/*
 * Copyright 2012 Gayan Perera
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *   http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package gap.maven.script.components.api;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * This annotation is used to annotate dependencies in the script's import
 * statements. The annotation processor will resolve the dependency and add it
 * to groovy class path at compilation time.<br>
 * 
 * This supports main maven dependency parameters such as groupdId, artifactId,
 * version, type and classifier.
 * 
 * @author gayan
 * 
 */
@Retention(RetentionPolicy.SOURCE)
@Target({ ElementType.TYPE })
public @interface Require {

    /**
     * Group id of the dependency.
     */
    String groupId();

    /**
     * Artifact id of the dependency.
     */
    String artifactId();

    /**
     * Version of the dependency.
     */
    String version();

    /**
     * Type of the dependency. The default value is "jar".
     */
    String type() default "jar";

    /**
     * Classifier of the dependency. The default value is empty.
     */
    String classifier() default "";
}
